Add docstrings to show short_help when running --help #2542
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This addresses #2381 by adding docstrings to cli commands which allows Click to display some informative help text when running --help. This change simply maps the existing
short_help
field to a docstring.Moreover, this doesn't cause the truncation issue mentioned in #2381 because
short_help
is already defined and overrides the 45 character truncation Click uses by default. Indeed, runningpipenv --help
locally results in status quo behavior:Result